chore: document CHANGELOG.md update requirement for variable changes#331
Merged
chore: document CHANGELOG.md update requirement for variable changes#331
Conversation
Member
|
@schaluva can you review this please? (I've modified and restructured content in the spirit of this PR, but this is basically my PR now so I shouldn't be the one to approve). |
schaluva
approved these changes
May 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a Terraform Conventions bullet to
CLAUDE.mdso future Claude Code sessions (and humans) know that any PR which adds, removes, or modifies a variable invariables.tf/templates/TEMPLATE_terraform.tfvarsmust update the upcoming-release section ofCHANGELOG.mdin the same PR.Why:
documentation/upgrade_steps.mdstep 5 directs upgraders to CHANGELOG forterraform.tfvarsguidance. If a new variable lands without a CHANGELOG row, upgrading customers won't know to set it and silently inherit defaults. Caught while triaging #312.Automated triage by Claude Code.